home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / lfmt.z / lfmt
Encoding:
Text File  |  2001-04-17  |  9.7 KB  |  197 lines
  1.  
  2.  
  3.  
  4. llllffffmmmmtttt((((1111))))                                                                llllffffmmmmtttt((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _llll_ffff_mmmm_tttt - display error message in standard format and pass to logging and
  10.      monitoring services
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      lfmt [-c] [-f _f_l_a_g_s_]]]] _[[[[_----_llll _l_a_b_e_l_]]]]_[[[[_----_ssss _s_e_v_e_r_i_t_y_]]]]_[[[[_----_GGGG _i_c_o_n_]]]]_[[[[_----_gggg _c_a_t_a_l_o_g_::::_m_s_g_i_d_]]]] _f_o_r_m_a_t _[[[[_a_r_g_s_]]]]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      _llll_ffff_mmmm_tttt uses _f_o_r_m_a_t for _pppp_rrrr_iiii_nnnn_tttt_ffff style formatting of _a_r_g_s.  _llll_ffff_mmmm_tttt encapsulates
  17.      the output in the standard error message format and displays the output
  18.      on _s_t_d_e_r_r.  In addition, _llll_ffff_mmmm_tttt forwards its output to the logging and
  19.      monitoring facility.
  20.  
  21.      The following options are available.
  22.  
  23.      _----_cccc          Also write the output to the console logger device
  24.                  (_////_dddd_eeee_vvvv_////_cccc_oooo_nnnn_ssss_llll_oooo_gggg), with a date and time stamp. This device is
  25.                  not normally used with IRIX.
  26.  
  27.      _----_ffff _f_l_a_g_s    Specify logging information as a comma-separated list of
  28.                  keywords from the following sets:
  29.  
  30.                  _M_a_j_o_r _c_l_a_s_s_i_f_i_c_a_t_i_o_n
  31.                              Identifies the source of the condition.
  32.                              Identifiers are:  _hhhh_aaaa_rrrr_dddd (hardware), _ssss_oooo_ffff_tttt
  33.                              (software), and _ffff_iiii_rrrr_mmmm (firmware).
  34.  
  35.                  _M_e_s_s_a_g_e _s_o_u_r_c_e _s_u_b_c_l_a_s_s_i_f_i_c_a_t_i_o_n
  36.                              Identifies the type of software in which the
  37.                              problem is spotted.  Identifiers are:  _aaaa_pppp_pppp_llll
  38.                              (application), _uuuu_tttt_iiii_llll (utility), and _oooo_pppp_ssss_yyyy_ssss
  39.                              (operating system).
  40.  
  41.      _----_GGGG _i_c_o_n     When the output device is the graphics console start up
  42.                  screen (called the ``textport''), this option causes the
  43.                  message to be drawn in a structured alert message box.  The
  44.                  _i_c_o_n argument specifies which icon to use and is either 0, 1,
  45.                  2, 3, or 4, for Info, Progress, Question, Warning, or Action
  46.                  icons.  This option is intended to be used in start up and
  47.                  shut down scripts.
  48.  
  49.      _----_gggg _c_a_t_a_l_o_g_::::_m_s_g_i_d
  50.                  Specify that a localized version of _f_o_r_m_a_t should be
  51.                  retrieved from a locale-specific message database.  _c_a_t_a_l_o_g
  52.                  indicates the message database that contains the localized
  53.                  version of the _f_o_r_m_a_t string.  _c_a_t_a_l_o_g must be limited to 14
  54.                  characters.  These characters must be selected from a set of
  55.                  all character values, excluding _\\\\_0000 (null) and the ASCII codes
  56.                  for _//// (slash) and _:::: (colon).
  57.                  _m_s_g_i_d is a positive number that indicates the index of the
  58.                  string into the message database.
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. llllffffmmmmtttt((((1111))))                                                                llllffffmmmmtttt((((1111))))
  70.  
  71.  
  72.  
  73.                  If _c_a_t_a_l_o_g does not exist in the current locale (identified
  74.                  by the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS or _LLLL_AAAA_NNNN_GGGG environment variables), or if
  75.                  _m_s_g_i_d is out of bounds, _llll_ffff_mmmm_tttt will attempt to retrieve the
  76.                  message from the C locale.  If this second retrieval fails,
  77.                  _llll_ffff_mmmm_tttt uses the _f_o_r_m_a_t string as passed on the command line.
  78.                  _llll_ffff_mmmm_tttt will output _MMMM_eeee_ssss_ssss_aaaa_gggg_eeee _nnnn_oooo_tttt _ffff_oooo_uuuu_nnnn_dddd_!!!!_!!!!_\\\\_nnnn as the _f_o_r_m_a_t string
  79.                  if _c_a_t_a_l_o_g is not a valid catalog name, or if _m_s_g_i_d is not a
  80.                  valid number as defined above.
  81.  
  82.      _----_llll _l_a_b_e_l    Specify the label string to be displayed with the message
  83.                  (for example, _""""_UUUU_XXXX_::::_cccc_aaaa_tttt_"""").  _l_a_b_e_l is a character string no more
  84.                  than 25 characters in length; it will be automatically
  85.                  suffixed with a colon (_::::).  When unspecified, no label is
  86.                  displayed as part of the message.
  87.  
  88.      _----_ssss _s_e_v_e_r_i_t_y Specify the severity string to be displayed with the message.
  89.                  Acceptable strings include the standard severities in either
  90.                  their print string (that is, _HHHH_AAAA_LLLL_TTTT, _EEEE_RRRR_RRRR_OOOO_RRRR, _IIII_NNNN_FFFF_OOOO, _WWWW_AAAA_RRRR_NNNN_IIII_NNNN_GGGG, and
  91.                  _""""_TTTT_OOOO _FFFF_IIII_XXXX_"""") or keyword (that is, _hhhh_aaaa_llll_tttt, _eeee_rrrr_rrrr_oooo_rrrr, _iiii_nnnn_ffff_oooo, _wwww_aaaa_rrrr_nnnn, and
  92.                  _aaaa_cccc_tttt_iiii_oooo_nnnn) forms, or any other user-defined string.  A user-
  93.                  defined string will be assigned the integer severity value of
  94.                  5.  The severity will be suffixed with a colon (_::::).  The
  95.                  _EEEE_RRRR_RRRR_OOOO_RRRR severity will be used if no severity is specified.
  96.  
  97.    SSSSttttaaaannnnddddaaaarrrrdddd EEEErrrrrrrroooorrrr MMMMeeeessssssssaaaaggggeeee FFFFoooorrrrmmmmaaaatttt
  98.      _llll_ffff_mmmm_tttt displays error messages in the following format:
  99.  
  100.           _l_a_b_e_l_:::: _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  101.  
  102.      If no _l_a_b_e_l was defined using the _----_llll _l_a_b_e_l option, the message is
  103.      displayed in the format:
  104.  
  105.           _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  106.  
  107.      If _llll_ffff_mmmm_tttt is called twice to display an error message and a helpful _a_c_t_i_o_n
  108.      or recovery message, the output can look like the following:
  109.  
  110.           _l_a_b_e_l_:::: _s_e_v_e_r_i_t_y_:::: _t_e_x_t
  111.           _l_a_b_e_l_:::: _TTTT_OOOO _FFFF_IIII_XXXX_:::: _t_e_x_t
  112.  
  113. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  114.      Example 1:
  115.  
  116.           _llll_ffff_mmmm_tttt _----_ffff _ssss_oooo_ffff_tttt_,,,,_uuuu_tttt_iiii_llll _----_llll _UUUU_XXXX_::::_tttt_eeee_ssss_tttt _----_ssss _iiii_nnnn_ffff_oooo _""""_tttt_eeee_ssss_tttt _ffff_aaaa_cccc_iiii_llll_iiii_tttt_yyyy _eeee_nnnn_aaaa_bbbb_llll_eeee_dddd_\\\\_nnnn_""""
  117.  
  118.      displays the message to _s_t_d_e_r_r and makes it available for logging:
  119.  
  120.           _UUUU_XXXX_::::_tttt_eeee_ssss_tttt_:::: _IIII_NNNN_FFFF_OOOO_:::: _tttt_eeee_ssss_tttt _ffff_aaaa_cccc_iiii_llll_iiii_tttt_yyyy _eeee_nnnn_aaaa_bbbb_llll_eeee_dddd
  121.  
  122.  
  123.  
  125.  
  126.  
  127.                                                                         PPPPaaaaggggeeee 2222
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134. llllffffmmmmtttt((((1111))))                                                                llllffffmmmmtttt((((1111))))
  135.  
  136.  
  137.  
  138. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  139.      _gggg_eeee_tttt_tttt_xxxx_tttt(1), _pppp_ffff_mmmm_tttt(1), _pppp_rrrr_iiii_nnnn_tttt_ffff(1), _llll_ffff_mmmm_tttt(3C), _pppp_ffff_mmmm_tttt(3C), _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5), _ssss_tttt_rrrr_aaaa_cccc_eeee(1),
  140.      _ssss_yyyy_ssss_llll_oooo_gggg(1).
  141.  
  142. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  143.      Upon success, _llll_ffff_mmmm_tttt exits with code 0.
  144.  
  145.      Upon failure, _llll_ffff_mmmm_tttt exits with the following codes:
  146.  
  147.      1    write error.
  148.  
  149.      2    cannot log or forward to console.
  150.  
  151.      3    syntax error.
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.                                                                         PPPPaaaaggggeeee 3333
  194.  
  195.  
  196.  
  197.